home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / prgtools / gnustuff / tos / othergnu / texinf~1.zoo / texinfo.st / bin / makeinfo.man < prev    next >
Encoding:
Text File  |  1993-06-28  |  4.0 KB  |  112 lines
  1. MAKEINFO(L)          ST Programmer's Manual          MAKEINFO(L)
  2.  
  3.  
  4.  
  5. NAME
  6.      makeinfo - format texinfo files into files suitable for
  7.      reading with GNU info.
  8.  
  9. SYNOPSIS
  10.      makeinfo [ --no-validate ] [ --no-pointer-validate ]
  11.      [ --no-warn ] [ --no-split ] [ --only-split ] [ --no-headers ]
  12.      [ --no-number-footnotes ] [ --number-footnotes ] [ --verbose ]
  13.      [ --version ] [ --output <name> ] [ --paragraph-indent <val>]
  14.      [ --fill-column <val> ] [ --error-limit <val> ]
  15.      [ -- reference-limit <val> ] [ --footnote-style <val> ]
  16.      [ -I <DIR> ] [ -D <VAR> ] [ -U <VAR> ] [ -o <name> ] [ -f <val> ]
  17.      [ -p <val> ] [ -e <val> ] [ -s <val> ] [ -f <val> ] [ -V ]
  18.      file ...
  19.  
  20. DESCRIPTION
  21.      Makefinfo reads texinfo file file and creates an output file
  22.      suitable for reading with GNU info.  Default name for output
  23.      is created from a basename by appending `.info' to it.  When
  24.      output file is big enough and --no-split option was not
  25.      specified then output is divided in smaller chunks and addi-
  26.      tional names will have suffixes like `.info-1', `.info-2'
  27.      and so on.  For systems where such long suffixes are not
  28.      supported `info' string is dropped and extra suffixes are
  29.      creates as `.-1', `.-2', ..., and so on.
  30.  
  31. OPTIONS
  32.      Some options may have both long and short forms.  Here is a
  33.      summary.
  34.  
  35.      -I   add <DIR> to the directory search list for including
  36.           files with the `@include' command.
  37.  
  38.      -D   define variable <VAR>, as with `@set' command
  39.  
  40.      -U   undefine variable <VAR>, as with `@clear' command
  41.  
  42.      --no-validate
  43.           suppres node cross reference validation.
  44.  
  45.      --no-pointer-validate
  46.           synonymous with --no-validate
  47.  
  48.      --no-warn
  49.           do not show warning messages (errors are still output).
  50.  
  51.      --no-split
  52.           do not split resulting info file
  53.  
  54.      --only-split
  55.           skip formatting and only split already formatted info
  56.           file.  Input file has to have tags table in it.
  57.  
  58.      --no-headers
  59.           do not write node headers, like `Node: Foo' to output
  60.           file.
  61.  
  62.      --verbose
  63.           be slightly more informative what you are doing
  64.  
  65.      --version,  -V
  66.           print the version number of makeinfo
  67.  
  68.      --paragraph-indent <val>,  -p <val>
  69.           set paragraph indent to <val>.  Accepted values are
  70.           `none', `asis' or a number of spaces to indent.  Nega-
  71.           tive values are treated as zero.  Default paragraph
  72.           indent is 3 spaces.
  73.  
  74.      --fill-column <val>, -f <val>
  75.           set fill column to <val>. Default column is 72.
  76.  
  77.      --error-limit <val>, -e <val>
  78.           stop processing when <val> errors is reached.  Default
  79.           is 100.
  80.  
  81.      --reference-limit <val>, -r <val>
  82.           warn when some node was referenced too many times.
  83.           Default is 1000.  o.IP "--footnote-style <style>, -s
  84.           <style>" set style either to `separate' where footnotes
  85.           are placed in their own node or to `end' (default)
  86.           where footnotes are output at the bottom of a node in
  87.           which they were defined.
  88.  
  89.      --number-footnotes
  90.           automatically number footnotes that have no specified
  91.           marker (default)
  92.  
  93.      --no-number-footnotes
  94.           if no specified marker, mark footnotes with '*'.
  95.  
  96.      --output, -o
  97.           specify name output file overriding `@setfilename' com-
  98.           mand, if any.
  99.  
  100. SEE ALSO
  101.      info(l), texindex(l)
  102.  
  103. BUGS
  104.      All processing is done in memory so makeinfo may fail with
  105.      bigger files when memory is limited.  If you got a failure
  106.      after the first stage  you still can use --only-split option
  107.      to split info file in a separate step.  This can be a pre-
  108.      ferred course of action when a disk space may be not ample
  109.      enough.  During an execution of both stages together mak-
  110.      einfo needs an extra disk space of roughly double size of an
  111.      original input.
  112.